<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>@aws/dynamodb-data-mapper</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="index.html" class="title">@aws/dynamodb-data-mapper</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="globals.html">Globals</a>
				</li>
			</ul>
			<h1> @aws/dynamodb-data-mapper</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Classes</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-class"><a href="classes/datamapper.html" class="tsd-kind-icon">Data<wbr>Mapper</a></li>
								<li class="tsd-kind-class"><a href="classes/itemnotfoundexception.html" class="tsd-kind-icon">Item<wbr>Not<wbr>Found<wbr>Exception</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/iterator.html" class="tsd-kind-icon">Iterator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/paginator.html" class="tsd-kind-icon">Paginator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/parallelscaniterator.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Iterator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/parallelscanpaginator.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Paginator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/queryiterator.html" class="tsd-kind-icon">Query<wbr>Iterator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/querypaginator.html" class="tsd-kind-icon">Query<wbr>Paginator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/scaniterator.html" class="tsd-kind-icon">Scan<wbr>Iterator</a></li>
								<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/scanpaginator.html" class="tsd-kind-icon">Scan<wbr>Paginator</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Interfaces</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-interface"><a href="interfaces/basescanoptions.html" class="tsd-kind-icon">Base<wbr>Scan<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/basesequentialscanoptions.html" class="tsd-kind-icon">Base<wbr>Sequential<wbr>Scan<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/batchgetoptions.html" class="tsd-kind-icon">Batch<wbr>Get<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/batchgettableoptions.html" class="tsd-kind-icon">Batch<wbr>Get<wbr>Table<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/batchstate.html" class="tsd-kind-icon">Batch<wbr>State</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/createtableoptions.html" class="tsd-kind-icon">Create<wbr>Table<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ctorbearer.html" class="tsd-kind-icon">Ctor<wbr>Bearer</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/datamapperconfiguration.html" class="tsd-kind-icon">Data<wbr>Mapper<wbr>Configuration</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/deleteoptions.html" class="tsd-kind-icon">Delete<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/deleteparameters.html" class="tsd-kind-icon">Delete<wbr>Parameters</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/documenttypeoptions.html" class="tsd-kind-icon">Document<wbr>Type<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/executeupdateexpressionoptions.html" class="tsd-kind-icon">Execute<wbr>Update<wbr>Expression<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/getoptions.html" class="tsd-kind-icon">Get<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/getparameters.html" class="tsd-kind-icon">Get<wbr>Parameters</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/globalsecondaryindexoptions.html" class="tsd-kind-icon">Global<wbr>Secondary<wbr>Index<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/initializedscanstate.html" class="tsd-kind-icon">Initialized<wbr>Scan<wbr>State</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/localsecondaryindexoptions.html" class="tsd-kind-icon">Local<wbr>Secondary<wbr>Index<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/parallelscanoptions.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/parallelscanworkeroptions.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Worker<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/perindexoptions.html" class="tsd-kind-icon">Per<wbr>Index<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/provisionedthroughput.html" class="tsd-kind-icon">Provisioned<wbr>Throughput</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/putoptions.html" class="tsd-kind-icon">Put<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/putparameters.html" class="tsd-kind-icon">Put<wbr>Parameters</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/queryoptions.html" class="tsd-kind-icon">Query<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/queryparameters.html" class="tsd-kind-icon">Query<wbr>Parameters</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/readconsistencyconfiguration.html" class="tsd-kind-icon">Read<wbr>Consistency<wbr>Configuration</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/scanoptions.html" class="tsd-kind-icon">Scan<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/sharedsecondaryindexoptions.html" class="tsd-kind-icon">Shared<wbr>Secondary<wbr>Index<wbr>Options</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/stringtoanyobjectmap.html" class="tsd-kind-icon">String<wbr>ToAny<wbr>Object<wbr>Map</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/uninitializedscanstate.html" class="tsd-kind-icon">Uninitialized<wbr>Scan<wbr>State</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/updateoptions.html" class="tsd-kind-icon">Update<wbr>Options</a></li>
								<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/updateparameters.html" class="tsd-kind-icon">Update<wbr>Parameters</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Type aliases</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-type-alias"><a href="globals.html#onmissingstrategy" class="tsd-kind-icon">On<wbr>Missing<wbr>Strategy</a></li>
								<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#parallelscanparameters" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Parameters</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#parallelscanstate" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>State</a></li>
								<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#parallelscanworkerparameters" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Worker<wbr>Parameters</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#readconsistency" class="tsd-kind-icon">Read<wbr>Consistency</a></li>
								<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#scanparameters" class="tsd-kind-icon">Scan<wbr>Parameters</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#scanstate" class="tsd-kind-icon">Scan<wbr>State</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#secondaryindexoptions" class="tsd-kind-icon">Secondary<wbr>Index<wbr>Options</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#secondaryindexprojection" class="tsd-kind-icon">Secondary<wbr>Index<wbr>Projection</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#sequentialscanoptions" class="tsd-kind-icon">Sequential<wbr>Scan<wbr>Options</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#streamviewtype" class="tsd-kind-icon">Stream<wbr>View<wbr>Type</a></li>
								<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="globals.html#syncorasynciterable" class="tsd-kind-icon">Sync<wbr>OrAsync<wbr>Iterable</a></li>
								<li class="tsd-kind-type-alias"><a href="globals.html#writetype" class="tsd-kind-icon">Write<wbr>Type</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Variables</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-variable"><a href="globals.html#dynamodbdirtyfields" class="tsd-kind-icon">Dynamo<wbr>DbDirty<wbr>Fields</a></li>
								<li class="tsd-kind-variable"><a href="globals.html#dynamodbschema" class="tsd-kind-icon">Dynamo<wbr>DbSchema</a></li>
								<li class="tsd-kind-variable"><a href="globals.html#dynamodbtable" class="tsd-kind-icon">Dynamo<wbr>DbTable</a></li>
								<li class="tsd-kind-variable"><a href="globals.html#max_read_batch_size" class="tsd-kind-icon">MAX_<wbr>READ_<wbr>BATCH_<wbr>SIZE</a></li>
								<li class="tsd-kind-variable"><a href="globals.html#max_write_batch_size" class="tsd-kind-icon">MAX_<wbr>WRITE_<wbr>BATCH_<wbr>SIZE</a></li>
								<li class="tsd-kind-variable"><a href="globals.html#version" class="tsd-kind-icon">VERSION</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#buildscaninput" class="tsd-kind-icon">build<wbr>Scan<wbr>Input</a></li>
								<li class="tsd-kind-function tsd-has-type-parameter"><a href="globals.html#embed" class="tsd-kind-icon">embed</a></li>
								<li class="tsd-kind-function"><a href="globals.html#getschema" class="tsd-kind-icon">get<wbr>Schema</a></li>
								<li class="tsd-kind-function"><a href="globals.html#gettablename" class="tsd-kind-icon">get<wbr>Table<wbr>Name</a></li>
								<li class="tsd-kind-function"><a href="globals.html#marshallstartkey" class="tsd-kind-icon">marshall<wbr>Start<wbr>Key</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Type aliases</h2>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="onmissingstrategy" class="tsd-anchor"></a>
					<h3>On<wbr>Missing<wbr>Strategy</h3>
					<div class="tsd-signature tsd-kind-icon">On<wbr>Missing<wbr>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"remove"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"skip"</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L7">constants.ts:7</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
					<a name="parallelscanparameters" class="tsd-anchor"></a>
					<h3>Parallel<wbr>Scan<wbr>Parameters</h3>
					<div class="tsd-signature tsd-kind-icon">Parallel<wbr>Scan<wbr>Parameters<span class="tsd-signature-symbol">:</span> <a href="interfaces/basescanoptions.html" class="tsd-signature-type">BaseScanOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ctorbearer.html" class="tsd-signature-type">CtorBearer</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/ScanOptions.ts#L153">namedParameters/ScanOptions.ts:153</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<dl class="tsd-comment-tags">
							<dt>deprecated</dt>
							<dd></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="parallelscanstate" class="tsd-anchor"></a>
					<h3>Parallel<wbr>Scan<wbr>State</h3>
					<div class="tsd-signature tsd-kind-icon">Parallel<wbr>Scan<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="globals.html#scanstate" class="tsd-signature-type">ScanState</a><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/ScanOptions.ts#L116">namedParameters/ScanOptions.ts:116</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>ParallelScanState is represented as an array whose length is equal to the
								number of segments being scanned independently, with each segment&#39;s state
							being stored at the array index corresponding to its segment number.</p>
						</div>
						<p>Segment state is represented with a tagged union with the following keys:</p>
						<ul>
							<li><code>initialized</code> -- whether the first page of results has been retrieved</li>
							<li><code>lastEvaluatedKey</code> -- the key to provide (if any) when requesting the
							next page of results.</li>
						</ul>
						<p>If <code>lastEvaluatedKey</code> is undefined and <code>initialized</code> is true, then all pages
						for the given segment have been returned.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
					<a name="parallelscanworkerparameters" class="tsd-anchor"></a>
					<h3>Parallel<wbr>Scan<wbr>Worker<wbr>Parameters</h3>
					<div class="tsd-signature tsd-kind-icon">Parallel<wbr>Scan<wbr>Worker<wbr>Parameters<span class="tsd-signature-symbol">:</span> <a href="interfaces/parallelscanworkeroptions.html" class="tsd-signature-type">ParallelScanWorkerOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ctorbearer.html" class="tsd-signature-type">CtorBearer</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/ScanOptions.ts#L146">namedParameters/ScanOptions.ts:146</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<dl class="tsd-comment-tags">
							<dt>deprecated</dt>
							<dd></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="readconsistency" class="tsd-anchor"></a>
					<h3>Read<wbr>Consistency</h3>
					<div class="tsd-signature tsd-kind-icon">Read<wbr>Consistency<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"eventual"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"strong"</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L9">constants.ts:9</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
					<a name="scanparameters" class="tsd-anchor"></a>
					<h3>Scan<wbr>Parameters</h3>
					<div class="tsd-signature tsd-kind-icon">Scan<wbr>Parameters<span class="tsd-signature-symbol">:</span> <a href="interfaces/scanoptions.html" class="tsd-signature-type">ScanOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/ctorbearer.html" class="tsd-signature-type">CtorBearer</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/ScanOptions.ts#L134">namedParameters/ScanOptions.ts:134</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<dl class="tsd-comment-tags">
							<dt>deprecated</dt>
							<dd></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="scanstate" class="tsd-anchor"></a>
					<h3>Scan<wbr>State</h3>
					<div class="tsd-signature tsd-kind-icon">Scan<wbr>State<span class="tsd-signature-symbol">:</span> <a href="interfaces/uninitializedscanstate.html" class="tsd-signature-type">UninitializedScanState</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/initializedscanstate.html" class="tsd-signature-type">InitializedScanState</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/ScanOptions.ts#L101">namedParameters/ScanOptions.ts:101</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="secondaryindexoptions" class="tsd-anchor"></a>
					<h3>Secondary<wbr>Index<wbr>Options</h3>
					<div class="tsd-signature tsd-kind-icon">Secondary<wbr>Index<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="interfaces/globalsecondaryindexoptions.html" class="tsd-signature-type">GlobalSecondaryIndexOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/localsecondaryindexoptions.html" class="tsd-signature-type">LocalSecondaryIndexOptions</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/SecondaryIndexOptions.ts#L22">namedParameters/SecondaryIndexOptions.ts:22</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="secondaryindexprojection" class="tsd-anchor"></a>
					<h3>Secondary<wbr>Index<wbr>Projection</h3>
					<div class="tsd-signature tsd-kind-icon">Secondary<wbr>Index<wbr>Projection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"keys"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/SecondaryIndexOptions.ts#L3">namedParameters/SecondaryIndexOptions.ts:3</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="sequentialscanoptions" class="tsd-anchor"></a>
					<h3>Sequential<wbr>Scan<wbr>Options</h3>
					<div class="tsd-signature tsd-kind-icon">Sequential<wbr>Scan<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="interfaces/scanoptions.html" class="tsd-signature-type">ScanOptions</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/parallelscanworkeroptions.html" class="tsd-signature-type">ParallelScanWorkerOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">object</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/ScanOptions.ts#L167">namedParameters/ScanOptions.ts:167</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<dl class="tsd-comment-tags">
							<dt>internal</dt>
							<dd></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="streamviewtype" class="tsd-anchor"></a>
					<h3>Stream<wbr>View<wbr>Type</h3>
					<div class="tsd-signature tsd-kind-icon">Stream<wbr>View<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"NEW_IMAGE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"OLD_IMAGE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"NEW_AND_OLD_IMAGES"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"KEYS_ONLY"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"NONE"</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/namedParameters/CreateTableOptions.ts#L9">namedParameters/CreateTableOptions.ts:9</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
					<a name="syncorasynciterable" class="tsd-anchor"></a>
					<h3>Sync<wbr>OrAsync<wbr>Iterable</h3>
					<div class="tsd-signature tsd-kind-icon">Sync<wbr>OrAsync<wbr>Iterable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L13">constants.ts:13</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias">
					<a name="writetype" class="tsd-anchor"></a>
					<h3>Write<wbr>Type</h3>
					<div class="tsd-signature tsd-kind-icon">Write<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"put"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"delete"</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L15">constants.ts:15</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Variables</h2>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="dynamodbdirtyfields" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> Dynamo<wbr>DbDirty<wbr>Fields</h3>
					<div class="tsd-signature tsd-kind-icon">Dynamo<wbr>DbDirty<wbr>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unique symbol</span><span class="tsd-signature-symbol"> =&nbsp;Symbol(&#x27;DynamoDbDirtyFields&#x27;)</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/protocols.ts#L111">protocols.ts:111</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Used to designate which fields on an object have been changed. The method
								identified by this symbol should return a iterable that enumerates the fields
							that have been altered.</p>
						</div>
						<dl class="tsd-comment-tags">
							<dt>example</dt>
							<dd><pre><code> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">FooDocument</span> </span>{
     <span class="hljs-keyword">constructor</span>() {
         <span class="hljs-keyword">this</span>._dirtyFields = new Set();
         <span class="hljs-keyword">this</span>._foo = <span class="hljs-string">''</span>;
     }

     <span class="hljs-keyword">get</span> foo() {
         <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>._foo;
     }

     <span class="hljs-keyword">set</span> foo(value) {
         <span class="hljs-keyword">this</span>._foo = value;
         <span class="hljs-keyword">this</span>._dirtyFields.add(<span class="hljs-string">'foo'</span>);
     }

     [DynamoDbDirtyFields]() {
         <span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>._dirtyFields.values();
     }
 }
</code></pre></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="dynamodbschema" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> Dynamo<wbr>DbSchema</h3>
					<div class="tsd-signature tsd-kind-icon">Dynamo<wbr>DbSchema<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unique symbol</span><span class="tsd-signature-symbol"> =&nbsp;Symbol(&#x27;DynamoDbSchema&#x27;)</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/protocols.ts#L33">protocols.ts:33</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Used to designate the mapping of an object from its JavaScript form to its
							representation in a DynamoDB Table or nested map.</p>
						</div>
						<dl class="tsd-comment-tags">
							<dt>example</dt>
							<dd><pre><code> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">FooDocument</span> </span>{
     [<span class="hljs-type">DynamoDbSchema</span>]() {
         <span class="hljs-keyword">return</span> {
             bar: {<span class="hljs-class"><span class="hljs-keyword">type</span></span>: <span class="hljs-symbol">'Strin</span>g'},
             baz: {<span class="hljs-class"><span class="hljs-keyword">type</span></span>: <span class="hljs-symbol">'Numbe</span>r'},
         };
     }
 }
</code></pre></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="dynamodbtable" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> Dynamo<wbr>DbTable</h3>
					<div class="tsd-signature tsd-kind-icon">Dynamo<wbr>DbTable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unique symbol</span><span class="tsd-signature-symbol"> =&nbsp;Symbol(&#x27;DynamoDbTableName&#x27;)</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/protocols.ts#L68">protocols.ts:68</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Used to designate that an object represents a row of the named DynamoDB
							table. Meant to be used in conjunction with {DynamoDbSchema}.</p>
						</div>
						<dl class="tsd-comment-tags">
							<dt>example</dt>
							<dd><pre><code> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">FooDocument</span> </span>{
     [<span class="hljs-type">DynamoDbTable</span>]() {
         <span class="hljs-keyword">return</span> <span class="hljs-symbol">'FooTabl</span>e';
     }

     [<span class="hljs-type">DynamoDbSchema</span>]() {
         <span class="hljs-keyword">return</span> {
             bar: {<span class="hljs-class"><span class="hljs-keyword">type</span></span>: <span class="hljs-symbol">'Strin</span>g'},
             baz: {<span class="hljs-class"><span class="hljs-keyword">type</span></span>: <span class="hljs-symbol">'Numbe</span>r'},
         };
     }
 }
</code></pre></dd>
						</dl>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="max_read_batch_size" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> MAX_<wbr>READ_<wbr>BATCH_<wbr>SIZE</h3>
					<div class="tsd-signature tsd-kind-icon">MAX_<wbr>READ_<wbr>BATCH_<wbr>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">100</span><span class="tsd-signature-symbol"> =&nbsp;100</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L5">constants.ts:5</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="max_write_batch_size" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> MAX_<wbr>WRITE_<wbr>BATCH_<wbr>SIZE</h3>
					<div class="tsd-signature tsd-kind-icon">MAX_<wbr>WRITE_<wbr>BATCH_<wbr>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">25</span><span class="tsd-signature-symbol"> =&nbsp;25</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L3">constants.ts:3</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="version" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> VERSION</h3>
					<div class="tsd-signature tsd-kind-icon">VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"0.4.0"</span><span class="tsd-signature-symbol"> =&nbsp;&quot;0.4.0&quot;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/constants.ts#L1">constants.ts:1</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
					<a name="buildscaninput" class="tsd-anchor"></a>
					<h3>build<wbr>Scan<wbr>Input</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
						<li class="tsd-signature tsd-kind-icon">build<wbr>Scan<wbr>Input&lt;T&gt;<span class="tsd-signature-symbol">(</span>valueConstructor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZeroArgumentsConstructor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, options<span class="tsd-signature-symbol">?: </span><a href="globals.html#sequentialscanoptions" class="tsd-signature-type">SequentialScanOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ScanInput</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/buildScanInput.ts#L15">buildScanInput.ts:15</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<dl class="tsd-comment-tags">
									<dt>internal</dt>
									<dd></dd>
								</dl>
							</div>
							<h4 class="tsd-type-parameters-title">Type parameters</h4>
							<ul class="tsd-type-parameters">
								<li>
									<h4>T</h4>
								</li>
							</ul>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>valueConstructor: <span class="tsd-signature-type">ZeroArgumentsConstructor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="globals.html#sequentialscanoptions" class="tsd-signature-type">SequentialScanOptions</a><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ScanInput</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
					<a name="embed" class="tsd-anchor"></a>
					<h3>embed</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
						<li class="tsd-signature tsd-kind-icon">embed&lt;T&gt;<span class="tsd-signature-symbol">(</span>documentConstructor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ZeroArgumentsConstructor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DocumentType</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/embed.ts#L12">embed.ts:12</a></li>
								</ul>
							</aside>
							<h4 class="tsd-type-parameters-title">Type parameters</h4>
							<ul class="tsd-type-parameters">
								<li>
									<h4>T</h4>
								</li>
							</ul>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>documentConstructor: <span class="tsd-signature-type">ZeroArgumentsConstructor</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> __namedParameters: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
									<ul class="tsd-parameters">
									</ul>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DocumentType</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="getschema" class="tsd-anchor"></a>
					<h3>get<wbr>Schema</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Schema<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Schema</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/protocols.ts#L35">protocols.ts:35</a></li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>item: <span class="tsd-signature-type">any</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Schema</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="gettablename" class="tsd-anchor"></a>
					<h3>get<wbr>Table<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Table<wbr>Name<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, tableNamePrefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/protocols.ts#L70">protocols.ts:70</a></li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>item: <span class="tsd-signature-type">any</span></h5>
								</li>
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> tableNamePrefix: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;&quot;</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="marshallstartkey" class="tsd-anchor"></a>
					<h3>marshall<wbr>Start<wbr>Key</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">marshall<wbr>Start<wbr>Key<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Schema</span>, startKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Key</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper/src/marshallStartKey.ts#L7">marshallStartKey.ts:7</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<dl class="tsd-comment-tags">
									<dt>internal</dt>
									<dd></dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>schema: <span class="tsd-signature-type">Schema</span></h5>
								</li>
								<li>
									<h5>startKey: <span class="tsd-signature-type">object</span></h5>
									<ul class="tsd-parameters">
										<li class="tsd-parameter-index-signature">
											<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
										</li>
									</ul>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Key</span></h4>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals current ">
						<a href="globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="classes/datamapper.html" class="tsd-kind-icon">Data<wbr>Mapper</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/itemnotfoundexception.html" class="tsd-kind-icon">Item<wbr>Not<wbr>Found<wbr>Exception</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/iterator.html" class="tsd-kind-icon">Iterator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/paginator.html" class="tsd-kind-icon">Paginator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/parallelscaniterator.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/parallelscanpaginator.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Paginator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/queryiterator.html" class="tsd-kind-icon">Query<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/querypaginator.html" class="tsd-kind-icon">Query<wbr>Paginator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/scaniterator.html" class="tsd-kind-icon">Scan<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="classes/scanpaginator.html" class="tsd-kind-icon">Scan<wbr>Paginator</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/basescanoptions.html" class="tsd-kind-icon">Base<wbr>Scan<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/basesequentialscanoptions.html" class="tsd-kind-icon">Base<wbr>Sequential<wbr>Scan<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/batchgetoptions.html" class="tsd-kind-icon">Batch<wbr>Get<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/batchgettableoptions.html" class="tsd-kind-icon">Batch<wbr>Get<wbr>Table<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/batchstate.html" class="tsd-kind-icon">Batch<wbr>State</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/createtableoptions.html" class="tsd-kind-icon">Create<wbr>Table<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/ctorbearer.html" class="tsd-kind-icon">Ctor<wbr>Bearer</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/datamapperconfiguration.html" class="tsd-kind-icon">Data<wbr>Mapper<wbr>Configuration</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/deleteoptions.html" class="tsd-kind-icon">Delete<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/deleteparameters.html" class="tsd-kind-icon">Delete<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/documenttypeoptions.html" class="tsd-kind-icon">Document<wbr>Type<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/executeupdateexpressionoptions.html" class="tsd-kind-icon">Execute<wbr>Update<wbr>Expression<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/getoptions.html" class="tsd-kind-icon">Get<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/getparameters.html" class="tsd-kind-icon">Get<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/globalsecondaryindexoptions.html" class="tsd-kind-icon">Global<wbr>Secondary<wbr>Index<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/initializedscanstate.html" class="tsd-kind-icon">Initialized<wbr>Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/localsecondaryindexoptions.html" class="tsd-kind-icon">Local<wbr>Secondary<wbr>Index<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/parallelscanoptions.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/parallelscanworkeroptions.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Worker<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/perindexoptions.html" class="tsd-kind-icon">Per<wbr>Index<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/provisionedthroughput.html" class="tsd-kind-icon">Provisioned<wbr>Throughput</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/putoptions.html" class="tsd-kind-icon">Put<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/putparameters.html" class="tsd-kind-icon">Put<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/queryoptions.html" class="tsd-kind-icon">Query<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/queryparameters.html" class="tsd-kind-icon">Query<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/readconsistencyconfiguration.html" class="tsd-kind-icon">Read<wbr>Consistency<wbr>Configuration</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/scanoptions.html" class="tsd-kind-icon">Scan<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/sharedsecondaryindexoptions.html" class="tsd-kind-icon">Shared<wbr>Secondary<wbr>Index<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/stringtoanyobjectmap.html" class="tsd-kind-icon">String<wbr>ToAny<wbr>Object<wbr>Map</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/uninitializedscanstate.html" class="tsd-kind-icon">Uninitialized<wbr>Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/updateoptions.html" class="tsd-kind-icon">Update<wbr>Options</a>
					</li>
					<li class=" tsd-kind-interface tsd-has-type-parameter">
						<a href="interfaces/updateparameters.html" class="tsd-kind-icon">Update<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#onmissingstrategy" class="tsd-kind-icon">On<wbr>Missing<wbr>Strategy</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
						<a href="globals.html#parallelscanparameters" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#parallelscanstate" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
						<a href="globals.html#parallelscanworkerparameters" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Worker<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#readconsistency" class="tsd-kind-icon">Read<wbr>Consistency</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
						<a href="globals.html#scanparameters" class="tsd-kind-icon">Scan<wbr>Parameters</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#scanstate" class="tsd-kind-icon">Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#secondaryindexoptions" class="tsd-kind-icon">Secondary<wbr>Index<wbr>Options</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#secondaryindexprojection" class="tsd-kind-icon">Secondary<wbr>Index<wbr>Projection</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#sequentialscanoptions" class="tsd-kind-icon">Sequential<wbr>Scan<wbr>Options</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#streamviewtype" class="tsd-kind-icon">Stream<wbr>View<wbr>Type</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-has-type-parameter">
						<a href="globals.html#syncorasynciterable" class="tsd-kind-icon">Sync<wbr>OrAsync<wbr>Iterable</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#writetype" class="tsd-kind-icon">Write<wbr>Type</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#dynamodbdirtyfields" class="tsd-kind-icon">Dynamo<wbr>DbDirty<wbr>Fields</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#dynamodbschema" class="tsd-kind-icon">Dynamo<wbr>DbSchema</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#dynamodbtable" class="tsd-kind-icon">Dynamo<wbr>DbTable</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#max_read_batch_size" class="tsd-kind-icon">MAX_<wbr>READ_<wbr>BATCH_<wbr>SIZE</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#max_write_batch_size" class="tsd-kind-icon">MAX_<wbr>WRITE_<wbr>BATCH_<wbr>SIZE</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#version" class="tsd-kind-icon">VERSION</a>
					</li>
					<li class=" tsd-kind-function tsd-has-type-parameter">
						<a href="globals.html#buildscaninput" class="tsd-kind-icon">build<wbr>Scan<wbr>Input</a>
					</li>
					<li class=" tsd-kind-function tsd-has-type-parameter">
						<a href="globals.html#embed" class="tsd-kind-icon">embed</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#getschema" class="tsd-kind-icon">get<wbr>Schema</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#gettablename" class="tsd-kind-icon">get<wbr>Table<wbr>Name</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#marshallstartkey" class="tsd-kind-icon">marshall<wbr>Start<wbr>Key</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer>
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>